home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / xvidoc.zip / XVI.LST < prev   
File List  |  1992-07-28  |  17KB  |  529 lines

  1.  
  2.  
  3.  
  4. XVI(1)                   USER COMMANDS                     XVI(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      xvi - multi-file text editor
  10.  
  11. SYNOPSIS
  12.      xvi { -s  _p_a_r_a_m_e_t_e_r-_a_s_s_i_g_n_m_e_n_t  }  [  -t  _t_a_g  |  +_n_u_m_b_e_r  |
  13.      +/_p_a_t_t_e_r_n ] { _f_i_l_e_n_a_m_e ...  }
  14.  
  15. DESCRIPTION
  16.      Xvi (pronounced _e_c_k_s-_v_e_e-_e_y_e) is a  free,  portable,  multi-
  17.      window  implementation  of the popular vi(1) editor.  It has
  18.      some useful enhancements, although, as described below,  not
  19.      all  of  vi's  features  have been implemented yet, and some
  20.      things work differently from vi.
  21.  
  22. OPTIONS
  23.      The following command-line options are available:
  24.  
  25.      -s _p_a_r_a_m_e_t_e_r-_a_s_s_i_g_n_m_e_n_t
  26.       Set the value of the specified  parameter  at  startup.
  27.       The  assignment  has  the same form as when given as an
  28.       editor command, i.e:
  29.  
  30.       _n_a_m_e=_s_t_r_i_n_g
  31.            for string parameters
  32.  
  33.       _n_a_m_e=_n_u_m_b_e_r
  34.            for numeric parameters
  35.  
  36.       _n_a_m_e to turn a Boolean parameter on
  37.  
  38.       no_n_a_m_e
  39.            to turn a Boolean parameter off
  40.  
  41.      -t _t_a_g
  42.       Edit the file containing the  definition  specified  as
  43.       _t_a_g, at the start of the definition (as per vi).
  44.  
  45.      +_n_u_m_b_e_r
  46.       Go to the specified  line  number  of  the  file  being
  47.       edited.
  48.  
  49.      +/_p_a_t_t_e_r_n
  50.       Go to the first occurrence  of  the  specified  _p_a_t_t_e_r_n
  51.       within the file being edited.
  52.  
  53.      The -r command line option is not supported.
  54.  
  55. ENHANCEMENTS
  56.   Multiple buffers and windows
  57.      A _b_u_f_f_e_r is the  internal  object  which  holds  a  file  in
  58.      memory,  while a _w_i_n_d_o_w is an area of the screen which shows
  59.      part of a buffer.  Every window references a buffer, even if
  60.  
  61.  
  62.  
  63. Unix                 Last change: 19/6/1992                     1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XVI(1)                   USER COMMANDS                     XVI(1)
  71.  
  72.  
  73.  
  74.      no  file  is  being  edited.   The  following  commands  are
  75.      available for operating on buffers and windows:
  76.  
  77.      :buffer
  78.       create a new buffer in a new window; can be followed by
  79.       a filename, which will be edited in the new buffer.
  80.  
  81.      :split
  82.       create a  new  window  on  to  the  current  buffer  by
  83.       splitting   the   current  window  in  half.   The  two
  84.       resulting windows are similar  to  _v_i_e_w_p_o_r_t_s  on  to  a
  85.       single  editing  buffer,  in  that  changes made in one
  86.       window are reflected in the other one.
  87.  
  88.      :close
  89.       close the current window; will also close the buffer if
  90.       this is the last window on to it.
  91.  
  92.      :x / ZZ
  93.       close only the current window.  If the  window  is  the
  94.       only one on to the buffer, the buffer will be closed as
  95.       well, writing it first if it is modified.
  96.  
  97.      g    move to the next window.
  98.  
  99.      ^W   increase the size of the current window (may be given a
  100.       numeric prefix, default is one line).
  101.  
  102.      ^T   decrease the size of the current window (may be given a
  103.       numeric prefix, default is one line).
  104.  
  105.      ^O   make the current window as large as possible.
  106.  
  107.      ^]   as  for  vi,  but  create  a  new  buffer   window   if
  108.       appropriate (and if autosplit allows).
  109.  
  110.      Note that the :quit command quits out of the editor, not out
  111.      of  a  window.  The :close command is thus the equivalent of
  112.      :quit for windows.  There is no equivalent of :x or  ZZ  for
  113.      the whole editor; these have been hijacked for operations on
  114.      windows.
  115.  
  116.      The numeric autosplit parameter specifies the maximum number
  117.      of   buffer  windows  that  will  be  created  automatically
  118.      whenever you either edit more than one file, or use tags  to
  119.      edit a different file.
  120.  
  121.      Undo works per buffer, as do marks; yank/put and redo (the .
  122.      command) work over all buffers, i.e. you can delete from one
  123.      buffer and put the text into a different buffer.
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Unix                 Last change: 19/6/1992                     2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XVI(1)                   USER COMMANDS                     XVI(1)
  137.  
  138.  
  139.  
  140.   File preservation
  141.      Rather than use vi's Unix-specific method for  preservation,
  142.      xvi  does periodic preservation of all files currently being
  143.      edited into temporary files in the same directory.  It tries
  144.      to  do this when you aren't typing, so that you won't notice
  145.      the short delay when the  temporary  file  is  written  out.
  146.      Obviously, only changed files are preserved in this way, and
  147.      the temporary file is removed once the real  file  has  been
  148.      successfully written.
  149.  
  150.   8-bit character support
  151.      Characters with the top bit set are accepted by xvi, but  it
  152.      is  not  yet  possible  to  have null ('\0') bytes in a file
  153.      buffer.  How characters are displayed can be  controlled  by
  154.      the  cchars  and  mchars  parameters,  which,  if set, cause
  155.      control  and  meta-characters  respectively  to  be   output
  156.      unchanged;   otherwise   they  are  shown  as  sequences  of
  157.      printable characters.
  158.  
  159.      Tabs are normally displayed as a series  of  spaces  of  the
  160.      appropriate  length  (according  to the tabstops parameter);
  161.      setting list mode will cause them to be displayed as control
  162.      characters,  as  will unsetting the tabs parameter.  How the
  163.      tab character is displayed is then under the control of  the
  164.      cchars parameter.
  165.  
  166.      You can use the ^_ (control-underscore) command to flip  the
  167.      top  bit  of  the  character  the cursor is on.  This may be
  168.      useful on systems where it is otherwise impossible to  enter
  169.      8-bit characters.
  170.  
  171.   File formats
  172.      Xvi can read and write text files in non-Unix formats.   The
  173.      current   format  is  given  by  the  value  of  the  format
  174.      parameter, which may be set to "unix", "msdos", etc.  To see
  175.      a list of available formats, type
  176.  
  177.       :se fmt=?
  178.  
  179.   Extended regular expressions
  180.      vi's  magic  parameter  is  superseded  by   the   regextype
  181.      parameter, which can take the following values:
  182.  
  183.      tags only ^ and $ are significant (used for tags)
  184.  
  185.      grep like grep(1), but with \< and \> added
  186.  
  187.      egrep
  188.       like egrep(1), but with \< and \> added
  189.  
  190.      The default is grep.
  191.  
  192.  
  193.  
  194.  
  195. Unix                 Last change: 19/6/1992                     3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XVI(1)                   USER COMMANDS                     XVI(1)
  203.  
  204.  
  205.  
  206.      Note that it is still possible to set or unset magic  as  in
  207.      vi;  this  will  simply  result  in  regextype  being set as
  208.      appropriate.
  209.  
  210.      The sections and paragraphs  parameters  define  egrep-style
  211.      patterns  to  search  for,  rather than vi's simplistic (and
  212.      troff-dependent) character pairs.
  213.  
  214.   Improved replace mode
  215.      The R command acts more intelligently when you press  return
  216.      -  it  leaves  the  rest of the current line alone, and just
  217.      starts replacing text on the  next  line,  starting  at  the
  218.      screen column where you first typed R.
  219.  
  220.   Command re-execution
  221.      As well as the normal named  (conjugate)  buffers,  and  the
  222.      default  one (named @), there exist several extra ones named
  223.      :, /, ? and !, which contain the last command lines typed to
  224.      each  of  the  given commands.  So for instance, @: will re-
  225.      execute the last ex command, or you can insert it into  your
  226.      buffer, edit it and then re-execute it (e.g. with dd@@).
  227.  
  228.   Jumpscroll
  229.      When multiple windows are used, xvi normally has to be  able
  230.      to  scroll  individual  windows  without scrolling the whole
  231.      screen.  This can be very inefficient on  terminals  without
  232.      scrolling  regions,  so the jumpscroll parameter is provided
  233.      to control the editor's scrolling behaviour.  It can be  set
  234.      to one of:
  235.  
  236.      off  When the cursor moves outside  a  window's  boundaries,
  237.       and  the  new  position is near enough, the window will
  238.       scroll to the new position.
  239.  
  240.      on   When the cursor moves outside  a  window's  boundaries,
  241.       the window will always jump to the new position.
  242.  
  243.      auto A window will scroll only if it can do so  efficiently;
  244.       otherwise it will jump.
  245.  
  246.      The default value is auto.
  247.  
  248.      On  ISA-type  systems  which  have  memory-map